<HTML>
<BODY BGCOLOR="white">
<PRE>
<FONT color="green">001</FONT>    package org.hackystat.sensor.ant.dependencyfinder;<a name="line.1"></a>
<FONT color="green">002</FONT>    <a name="line.2"></a>
<FONT color="green">003</FONT>    import java.io.File;<a name="line.3"></a>
<FONT color="green">004</FONT>    import java.util.ArrayList;<a name="line.4"></a>
<FONT color="green">005</FONT>    import java.util.Date;<a name="line.5"></a>
<FONT color="green">006</FONT>    import java.util.HashMap;<a name="line.6"></a>
<FONT color="green">007</FONT>    import java.util.List;<a name="line.7"></a>
<FONT color="green">008</FONT>    import java.util.Map;<a name="line.8"></a>
<FONT color="green">009</FONT>    <a name="line.9"></a>
<FONT color="green">010</FONT>    import javax.xml.bind.JAXBContext;<a name="line.10"></a>
<FONT color="green">011</FONT>    import javax.xml.bind.Unmarshaller;<a name="line.11"></a>
<FONT color="green">012</FONT>    import javax.xml.datatype.XMLGregorianCalendar;<a name="line.12"></a>
<FONT color="green">013</FONT>    <a name="line.13"></a>
<FONT color="green">014</FONT>    import org.apache.tools.ant.BuildException;<a name="line.14"></a>
<FONT color="green">015</FONT>    import org.hackystat.sensor.ant.dependencyfinder.jaxb.Dependencies;<a name="line.15"></a>
<FONT color="green">016</FONT>    import org.hackystat.sensor.ant.dependencyfinder.jaxb.Package;<a name="line.16"></a>
<FONT color="green">017</FONT>    import org.hackystat.sensor.ant.dependencyfinder.jaxb.Class;<a name="line.17"></a>
<FONT color="green">018</FONT>    import org.hackystat.sensor.ant.task.HackystatSensorTask;<a name="line.18"></a>
<FONT color="green">019</FONT>    import org.hackystat.sensor.ant.util.JavaClass2FilePathMapper;<a name="line.19"></a>
<FONT color="green">020</FONT>    import org.hackystat.utilities.tstamp.Tstamp;<a name="line.20"></a>
<FONT color="green">021</FONT>    <a name="line.21"></a>
<FONT color="green">022</FONT>    /**<a name="line.22"></a>
<FONT color="green">023</FONT>     * Implements an Ant task that parses the XML files generated by DependencyFinder. <a name="line.23"></a>
<FONT color="green">024</FONT>     * The Ant Task sends the Coupling data to a Hackystat server.<a name="line.24"></a>
<FONT color="green">025</FONT>     * <a name="line.25"></a>
<FONT color="green">026</FONT>     * @author Philip Johnson<a name="line.26"></a>
<FONT color="green">027</FONT>     */<a name="line.27"></a>
<FONT color="green">028</FONT>    public class DependencyFinderSensor extends HackystatSensorTask {<a name="line.28"></a>
<FONT color="green">029</FONT>    <a name="line.29"></a>
<FONT color="green">030</FONT>      /** The name of this tool. */<a name="line.30"></a>
<FONT color="green">031</FONT>      private static String tool = "DependencyFinder";<a name="line.31"></a>
<FONT color="green">032</FONT>    <a name="line.32"></a>
<FONT color="green">033</FONT>      /** Initialize a new instance of this sensor. */<a name="line.33"></a>
<FONT color="green">034</FONT>      public DependencyFinderSensor() {<a name="line.34"></a>
<FONT color="green">035</FONT>        super(tool);<a name="line.35"></a>
<FONT color="green">036</FONT>      }<a name="line.36"></a>
<FONT color="green">037</FONT>    <a name="line.37"></a>
<FONT color="green">038</FONT>      /**<a name="line.38"></a>
<FONT color="green">039</FONT>       * Initialize a new instance of this sensor for testing purposes.<a name="line.39"></a>
<FONT color="green">040</FONT>       * <a name="line.40"></a>
<FONT color="green">041</FONT>       * @param host The SensorBase host URL.<a name="line.41"></a>
<FONT color="green">042</FONT>       * @param email The SensorBase email to use.<a name="line.42"></a>
<FONT color="green">043</FONT>       * @param password The SensorBase password to use.<a name="line.43"></a>
<FONT color="green">044</FONT>       */<a name="line.44"></a>
<FONT color="green">045</FONT>      public DependencyFinderSensor(String host, String email, String password) {<a name="line.45"></a>
<FONT color="green">046</FONT>        super(host, email, password, tool);<a name="line.46"></a>
<FONT color="green">047</FONT>      }<a name="line.47"></a>
<FONT color="green">048</FONT>    <a name="line.48"></a>
<FONT color="green">049</FONT>      /**<a name="line.49"></a>
<FONT color="green">050</FONT>       * Parses the tool's XML file and sends the resulting data to the SensorBase server.<a name="line.50"></a>
<FONT color="green">051</FONT>       * <a name="line.51"></a>
<FONT color="green">052</FONT>       * @throws BuildException If there is an error.<a name="line.52"></a>
<FONT color="green">053</FONT>       */<a name="line.53"></a>
<FONT color="green">054</FONT>      @Override<a name="line.54"></a>
<FONT color="green">055</FONT>      public void executeInternal() throws BuildException {<a name="line.55"></a>
<FONT color="green">056</FONT>        this.setupSensorShell();<a name="line.56"></a>
<FONT color="green">057</FONT>        int numberOfEntries = 0;<a name="line.57"></a>
<FONT color="green">058</FONT>        Date startTime = new Date();<a name="line.58"></a>
<FONT color="green">059</FONT>        for (File dataFile : getDataFiles()) {<a name="line.59"></a>
<FONT color="green">060</FONT>          try {<a name="line.60"></a>
<FONT color="green">061</FONT>            verboseInfo("Processing DependencyFinder file: " + dataFile);<a name="line.61"></a>
<FONT color="green">062</FONT>            numberOfEntries += this.processDependencyFinderXmlFile(dataFile);<a name="line.62"></a>
<FONT color="green">063</FONT>          }<a name="line.63"></a>
<FONT color="green">064</FONT>          catch (Exception e) {<a name="line.64"></a>
<FONT color="green">065</FONT>            signalError("Failure processing: " + dataFile, e);<a name="line.65"></a>
<FONT color="green">066</FONT>          }<a name="line.66"></a>
<FONT color="green">067</FONT>        }<a name="line.67"></a>
<FONT color="green">068</FONT>        // We've collected the data, now send it. <a name="line.68"></a>
<FONT color="green">069</FONT>        this.sendAndQuit();<a name="line.69"></a>
<FONT color="green">070</FONT>        summaryInfo(startTime, "Coupling", numberOfEntries);<a name="line.70"></a>
<FONT color="green">071</FONT>      }<a name="line.71"></a>
<FONT color="green">072</FONT>    <a name="line.72"></a>
<FONT color="green">073</FONT>      /**<a name="line.73"></a>
<FONT color="green">074</FONT>       * Processes a single DependencyFinder XML data file, generating sensor data.<a name="line.74"></a>
<FONT color="green">075</FONT>       * <a name="line.75"></a>
<FONT color="green">076</FONT>       * @param xmlFile The file containing the DependencyFinder data.<a name="line.76"></a>
<FONT color="green">077</FONT>       * @return The number of Coupling instances generated.<a name="line.77"></a>
<FONT color="green">078</FONT>       * @throws BuildException If problems occur.<a name="line.78"></a>
<FONT color="green">079</FONT>       */<a name="line.79"></a>
<FONT color="green">080</FONT>      int processDependencyFinderXmlFile(File xmlFile) throws BuildException {<a name="line.80"></a>
<FONT color="green">081</FONT>        // The start time for all entries will be approximated by the XML file's last mod time.<a name="line.81"></a>
<FONT color="green">082</FONT>        // Use the TstampSet to make it unique.<a name="line.82"></a>
<FONT color="green">083</FONT>        long startTime = xmlFile.lastModified();<a name="line.83"></a>
<FONT color="green">084</FONT>        int count = 0;<a name="line.84"></a>
<FONT color="green">085</FONT>        try {<a name="line.85"></a>
<FONT color="green">086</FONT>          JAXBContext context = JAXBContext<a name="line.86"></a>
<FONT color="green">087</FONT>          .newInstance(org.hackystat.sensor.ant.dependencyfinder.jaxb.ObjectFactory.class);<a name="line.87"></a>
<FONT color="green">088</FONT>          Unmarshaller unmarshaller = context.createUnmarshaller();<a name="line.88"></a>
<FONT color="green">089</FONT>    <a name="line.89"></a>
<FONT color="green">090</FONT>          // DependencyFinder XML report.<a name="line.90"></a>
<FONT color="green">091</FONT>          Dependencies dependencies = (Dependencies) unmarshaller.unmarshal(xmlFile);<a name="line.91"></a>
<FONT color="green">092</FONT>          // Construct a mapper from class names to their file path.<a name="line.92"></a>
<FONT color="green">093</FONT>          JavaClass2FilePathMapper mapper = new JavaClass2FilePathMapper(getSourceFiles());<a name="line.93"></a>
<FONT color="green">094</FONT>          List&lt;Package&gt; packages = new ArrayList&lt;Package&gt;();<a name="line.94"></a>
<FONT color="green">095</FONT>          if (dependencies.getPackage() != null) { <a name="line.95"></a>
<FONT color="green">096</FONT>            packages = dependencies.getPackage();<a name="line.96"></a>
<FONT color="green">097</FONT>          }<a name="line.97"></a>
<FONT color="green">098</FONT>    <a name="line.98"></a>
<FONT color="green">099</FONT>          for (Package packageElement : packages) {<a name="line.99"></a>
<FONT color="green">100</FONT>            List&lt;Class&gt; classList = new ArrayList&lt;Class&gt;();<a name="line.100"></a>
<FONT color="green">101</FONT>            if (packageElement.getClazz() != null) {<a name="line.101"></a>
<FONT color="green">102</FONT>              classList = packageElement.getClazz();<a name="line.102"></a>
<FONT color="green">103</FONT>            }<a name="line.103"></a>
<FONT color="green">104</FONT>            for (Class classElement : classList) {<a name="line.104"></a>
<FONT color="green">105</FONT>              String resource = mapper.getFilePath(classElement.getName());<a name="line.105"></a>
<FONT color="green">106</FONT>    <a name="line.106"></a>
<FONT color="green">107</FONT>              if (resource != null) {<a name="line.107"></a>
<FONT color="green">108</FONT>                long tstamp = this.tstampSet.getUniqueTstamp(startTime);<a name="line.108"></a>
<FONT color="green">109</FONT>                XMLGregorianCalendar tstampXml = Tstamp.makeTimestamp(tstamp);<a name="line.109"></a>
<FONT color="green">110</FONT>                XMLGregorianCalendar runtimeXml = Tstamp.makeTimestamp(this.runtime);<a name="line.110"></a>
<FONT color="green">111</FONT>                // Create the sensor data instance key/value map.<a name="line.111"></a>
<FONT color="green">112</FONT>                Map&lt;String, String&gt; keyValMap = new HashMap&lt;String, String&gt;();<a name="line.112"></a>
<FONT color="green">113</FONT>                // Required for all sensor data<a name="line.113"></a>
<FONT color="green">114</FONT>                keyValMap.put("Tool", tool);<a name="line.114"></a>
<FONT color="green">115</FONT>                keyValMap.put("SensorDataType", "Coupling");<a name="line.115"></a>
<FONT color="green">116</FONT>                keyValMap.put("Runtime", runtimeXml.toString());<a name="line.116"></a>
<FONT color="green">117</FONT>                keyValMap.put("Timestamp", tstampXml.toString());<a name="line.117"></a>
<FONT color="green">118</FONT>                keyValMap.put("Resource", resource);<a name="line.118"></a>
<FONT color="green">119</FONT>                // Expected for "Coupling" sensor data. <a name="line.119"></a>
<FONT color="green">120</FONT>                keyValMap.put("Type", "class");<a name="line.120"></a>
<FONT color="green">121</FONT>                keyValMap.put("Afferent", String.valueOf(getAfferent(classElement))); <a name="line.121"></a>
<FONT color="green">122</FONT>                keyValMap.put("Efferent", String.valueOf(getEfferent(classElement)));<a name="line.122"></a>
<FONT color="green">123</FONT>                // add data to sensorshell<a name="line.123"></a>
<FONT color="green">124</FONT>                this.sensorShell.add(keyValMap);<a name="line.124"></a>
<FONT color="green">125</FONT>                count++;<a name="line.125"></a>
<FONT color="green">126</FONT>              }<a name="line.126"></a>
<FONT color="green">127</FONT>            }<a name="line.127"></a>
<FONT color="green">128</FONT>          }<a name="line.128"></a>
<FONT color="green">129</FONT>        }<a name="line.129"></a>
<FONT color="green">130</FONT>        catch (Throwable e) {<a name="line.130"></a>
<FONT color="green">131</FONT>          throw new BuildException(errMsgPrefix + "Failure: " + e.getMessage(), e);<a name="line.131"></a>
<FONT color="green">132</FONT>        }<a name="line.132"></a>
<FONT color="green">133</FONT>        return count;<a name="line.133"></a>
<FONT color="green">134</FONT>      }<a name="line.134"></a>
<FONT color="green">135</FONT>    <a name="line.135"></a>
<FONT color="green">136</FONT>      /**<a name="line.136"></a>
<FONT color="green">137</FONT>       * Gets the Afferent (inbound) number of couplings.<a name="line.137"></a>
<FONT color="green">138</FONT>       * @param classElement The class element to count.<a name="line.138"></a>
<FONT color="green">139</FONT>       * @return The integer number of afferent links.<a name="line.139"></a>
<FONT color="green">140</FONT>       */<a name="line.140"></a>
<FONT color="green">141</FONT>      private int getAfferent(Class classElement) {<a name="line.141"></a>
<FONT color="green">142</FONT>        return (classElement.getInbound() == null) ? 0 : classElement.getInbound().size();<a name="line.142"></a>
<FONT color="green">143</FONT>      }<a name="line.143"></a>
<FONT color="green">144</FONT>      <a name="line.144"></a>
<FONT color="green">145</FONT>      /**<a name="line.145"></a>
<FONT color="green">146</FONT>       * Gets the Efferent (outbound) number of couplings.<a name="line.146"></a>
<FONT color="green">147</FONT>       * @param classElement The class element to count.<a name="line.147"></a>
<FONT color="green">148</FONT>       * @return The integer number of efferent links.<a name="line.148"></a>
<FONT color="green">149</FONT>       */<a name="line.149"></a>
<FONT color="green">150</FONT>      private int getEfferent(Class classElement) {<a name="line.150"></a>
<FONT color="green">151</FONT>        return (classElement.getOutbound() == null) ? 0 : classElement.getOutbound().size();<a name="line.151"></a>
<FONT color="green">152</FONT>      }<a name="line.152"></a>
<FONT color="green">153</FONT>    }<a name="line.153"></a>




























































</PRE>
</BODY>
</HTML>
